Minor wire_struct improvements:#480
Open
fdxmw wants to merge 2 commits intoUCSBarchlab:developmentfrom
Open
Conversation
* The concatenated value can be set with the special `kwarg` "_value". This is useful when the `wire_struct`'s class name is not known. * Changes to make `wire_struct` instances documentable with Sphinx. The generated class copies its docstring from the decorated class (`__doc__`), and the generated class's name now matches the decorated class's name. Previously all `wire_struct` classes were named `_WireStruct`. * Add a new `class_name` argument to `wire_matrix`. This lets users set the name of the generated class. This is optional for backwards compatibility, but highly recommended to help with debugging. Previously all `wire_matrix` classes were named `_WireMatrix`.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## development #480 +/- ##
=============================================
- Coverage 92.0% 91.9% -0.0%
=============================================
Files 31 31
Lines 7508 7503 -5
=============================================
- Hits 6901 6895 -6
- Misses 607 608 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The concatenated value can be set with the special
kwarg"_value". This is useful when thewire_struct's class name is not known.Changes to make
wire_structinstances documentable with Sphinx. The generated class copies its docstring from the decorated class (__doc__), and the generated class's name now matches the decorated class's name. Previously allwire_structclasses were named_WireStruct.Add a new
class_nameargument towire_matrix. This lets users set the name of the generated class. This is optional for backwards compatibility, but highly recommended to help with debugging. Previously allwire_matrixclasses were named_WireMatrix.